### “Sabai Directory” Documentation by “SabaiApps” v1.3.0

# “Sabai Directory”

Updated: Sep 28th, 2014
By: onokazu
Website: Portfolio at codecanyon.net

Thank you for purchasing my plugin. If you have any questions that are beyond the scope of this help file, please feel free to post questions on the comments page at codecanyon. Thanks so much!

## Table of Contents

1. Overview
2. Plugin Requirements
3. Installation
4. Quick Tour
5. Configuring Sabai Directory
6. Localization
7. Update Sabai Directory
8. FAQ

### A) Overview - top

Sabai Directory is a premium business directory plugin for WordPress. The plugin features the ability to build a community driven local business directories like Yelp.com, Google+ Places, or Yahoo! Local.

#### Resources

- Sabai Directory demo site

### B) Plugin Requirements - top

Before installing the plugin, please check that the following conditions are met on your server.

- PHP 5.2 or greater (with mbstring and curl extensions, and at least 128M memory_limit)
- MySQL 5.0.3 or greater
- WordPress 3.4 or greater
- WordPress permalink URL structure must be something other than Default

### C) Installation - top

The Sabai Directory plugin runs on top of an application framework called Sabai. Because of that, you must first install and activate the Sabai plugin. If you already have the Sabai plugin installed and activated, please skip Step 1: Install Sabai and go straight to Step 2: Install Sabai Directory.

#### Step 1: Install Sabai

1. Login to your website if not yet logged in and go to the WordPress administration dashboard.
2. Select Plugins -> Add New from the side menu.
3. Click the Upload link.
4. Upload the sabai.zip file included in the downloaded package.
5. Click the Activate Plugin link.

#### Step 2: Install Sabai Directory

Now that the Sabai plugin is installed and active, you can install the Sabai Directory plugin.

1. Login to your website if not yet logged in and go to the WordPress administration dashboard.
2. Select Plugins -> Add New from the side menu.
3. Click the Upload link.
4. Upload the sabai-directory.zip file included in the downloaded package.
5. Click the Activate Plugin link.

#### Step 3: Permalink Setting

Our plugins require the WordPress permalink setting to be set to other than the default. In order to do so, go to Settings -> Permalinks and under the Common Settings section, select any other option but the Default option.

#### Step 4: Install Sabai Googlem Maps (optional)

If you are going to enable Google maps with the plugin, install the Sabai Google Maps plugin.

1. Select Plugins -> Add New from the side menu.
2. Click the Upload link.
3. Upload the sabai-googlemaps.zip file included in the downloaded package.
4. Click the Activate Plugin link.

#### Step 5: Install Sabai Paid Listings (optional)

If you would like to enable paid listings so that you can charge users for submitting their listings or premium features, install the Sabai Paid Listings plugin.

1. Select Plugins -> Add New from the side menu.
2. Click the Upload link.
3. Upload the sabai-paidlistings.zip file included in the downloaded package.
4. Click the Activate Plugin link.
5. Select Settings -> Sabai from the side menu.
6. Scroll page down to the Installable Add-ons table under the Sabai Add-ons section.
7. Click the green + button for the PaidDirectoryListings add-on, which opens up a form in a popup window.
8. Click the Install Add-on button on the popup window.
9. Repeat 7 and 8 for the AuthorizeNet, 2Checkout, and Stripe payment gateway add-ons depending on what type of payment methods you would like to accept.

That's it! You have now successcully installed Sabai Directory on WordPress.

### D) Quick Tour - top

Here we learn briefly about the content that Sabai Directory adds to your WordPress installation.

#### Pages

Sabai Directory creates 3 new WordPress pages:

- Directory (slug: directory) - displays listings in list or map view.
- Directory Dashboard (slug: directory-dashboard) - displays the current user's claimed/submitted listings, orders, and bookmarks.
- Add Listing (slug: add-directory-listing) - displays a form for the users to submit their listings.

Other than the ordinary WordPress pages above, here are some of the pages that Sabai Directory generates internally and display them on the frontend.

- Single Listing Page (slug: directory/listing/[listing_slug]) - displays a single listing with reviews, photos, and a map.
- Category Listing Page (slug: directory/categories) - displays a list of all categories in the directory.
- Single Category Page (slug: directory/categories/[category_slug]) - displays the detailed description of a category, sub-categories of the category, and listings posted in that category in list or map view.
- All Reviews Page (slug: directory/reviews) - displays all reviews posted in the directory.
- All Photos Page (slug: directory/photos) - displays all photos posted in the directory.
- User Page (slug: directory/users/[user_name]) - displays all reviews, photos, and bookmarks posted by a user.
- RSS Feed (slug: directory/feeds) - RSS feeds of most recent 20 reviews in the directory.

#### Administration Pages

This is where you will create and manage listings, and adjust your settings. Let’s take a brief look at the menu items under the Directory section:

- Listings - manage listings and listing fields.
- Add Listing - direct link to add a new listing.
- Reviews - manage reviews and review fields.
- Photos - manage listing photos.
- Leads - manage listing leads.
- Categories - manage categories and category fields.
- Settings - all the settings you need to manage Sabai Directory.

#### ToolBar Menu

Sabai Directory adds a single menu item to the WordPress Toolbar, udner the user profile section.

- Directory Dashboard - links to the current user's directory dashboard page on the frontend.

### E) Configuring Sabai Directory - top

You should be able to run Sabai Directory without any problem with the default settings already configured out of the box. However, if you want customization, Sabai Directory settings can be found under the Settings page in the Directory menu.

#### General Settings (under "General" tab)

- Configure how listings, reviews, and photos are displayed, including number of posts per page, display order, and default view.

#### Map Settings (under "Map" tab, only when the Sabai Google Maps plugin is installed)

- Disable map - Use this option to temporarily disable the map feature of the plugin.
- Basic Settings - Configure basic settings of map displayed on listing and category pages.
- List View Settings - Enable/disable small map in List view and configure how it is displayed..
- Marker Cluster Settings -Enable/disable marker clusters and custom cluster image.

#### Search Settings (under "Search" tab)

- Keyword Search Settings - Configure how search keywords are handled.
- Location Search Settings - Configure how location search is handled.
- Category Search Settings - Disable/enable category search.
- Search Filter Settings - Configure how the search filter form is displayed.

#### Access Control Settings (under "Access Control" tab)

- Permissions - Configure permissions by user roles.

#### Claims Settings (under "Claims" tab)

- Duration Settings - Configure listing claim default duration and expiration grace period settings.
- Claim Listing Form Settings - Configure how the claim listing form is displayed.
- Approval Settings - Enable/disable automattic approval of claims.
- Unclaimed Listing Settings - Set the default features enabled for unclaimed listings such as the number of categories and photos, and available fields.

#### Spam Settings (under "Spam" tab)

- Allows you to configure how Sabai Directory handles undesirable listings, reviews, and photos.

#### Email Notification Templates Setings (under "Emails" tab)

- Listing Submitted Admin Notification Email - sent to administrators whenever a listing that requires approval is submitted.
- Review Submitted Admin Notification Email - sent to administrators whenever a review that requires approval is submitted.
- Photo Submitted Admin Notification Email - sent to administrators whenever a photo that requires approval is submitted.
- Listing Approved Notification Email - sent to the user when a listing the user has submitted is approved.
- Review Approved Notification Email - sent to the user when a review the user has submitted is approved.
- Photo Approved Notification Email - sent to the user when a photo the user has submitted is approved.
- Comment Posted Notification Email - sent to the review author when a comment is submitted.
- Review Added Notification Email - sent to the listing owner when a review is posted.
- Photo Added Notification Email - sent to the listing owner when photos are added to the listing.
- Listing Claim Expiration Notification Email - sent to the listing owner from 7 days before expiration of a claim until the claim expires.
- Listing Claim Expired Notification Email - sent to the listing owner after a claim has expired.
- Listing Published Notification Email - sent to users of selected roles whenever a listing is published.
- Review Published Notification Email - sent to users of selected roles whenever a review is published.
- Photo Published Notification Email - sent to users of selected roles whenever a photo is published.
- Listing Flagged Notification Email - sent to users of selected roles whenever a listing is flagged.
- Review Flagged Notification Email - sent to users of selected roles whenever a review is flagged.
- Photo Flagged Notification Email - sent to users of selected roles whenever a photo is flagged.
- Listing Claim Approved Notification Email - sent to the user when a claim the user has submitted is approved.
- Listing Claim Rejected Notification Email - sent to the user when a claim the user has submitted is rejected.
- Listing Claim Pending Admin Notification Email - sent to administrators whenever a listing claim is submitted for admin review.
- Order Received Notification Email - sent to the user when a user places an order.
- Order Complete Notification Email - sent to the user when an order is complete.
- Order Received Admin Notification Email - sent to administrators when a user place an order and payment received.
- Order Awaiting Fullfillment Admin Notification Email - sent to administrators when ordered items for an order are ready for delivery.

#### Pages Settings (under "General" tab)

- Page Settings - Configure which WordPress pages should be used to display Sabai Directory content.
- Slug Settings - Configure custom slugs for various pages.

Since the plugin allows you to create multiple instances of directory, some common settings can be found under the Sabai page in the Settings menu.

#### Comment Setings ("Settings" => "Sabai" => "Comment (cog icon)")

- Configure how comments are handled and displayed.

#### File Setings ("Settings" => "Sabai" => "File (cog icon)")

- Configure file upload directories, thumbnail size, thumbnail resize method, etc.

#### Social Sharing Setings ("Settings" => "Sabai" => "Social (cog icon)")

- Enable/disable social sharing of content and configure its settings.

The following settings are available when the Sabai Google Maps plugin is installed.

#### Google Maps Setings ("Settings" => "Sabai" => "GoogleMaps (cog icon)")

- Configure Google Maps API settings.

The following settings are available when the Sabai Paid Listings plugin and payment gateway add-ons are installed.

#### Manual Payment Setings ("Settings" => "Sabai" => "ManualPayment (cog icon)")

- Configure payment instructions displayed and/or sent to the customer when the manualy payment method is selected.

#### PayPal Setings ("Settings" => "Sabai" => "PayPal (cog icon)")

- Configure PayPal API settings.

#### Stripe Setings ("Settings" => "Sabai" => "Stripe (cog icon)")

- Configure Stripe API settings.

#### Authorize.net Setings ("Settings" => "Sabai" => "AuthorizeNet (cog icon)")

- Configure Authorize.net API settings.

#### 2Checkout Setings ("Settings" => "Sabai" => "2Checkout (cog icon)")

- Configure 2Checkout API settings.

### F) Localization - top

Sabai Directory is fully internationalized so that it can be translated into many languages. Translatable files are in the Gettext format, which is the standard format used in WordPress. There are following Gettext POT (.pot) files in the package:

- wp-content/plugins/sabai/languages/sabai.pot
- wp-content/plugins/sabai-directory/languages/sabai-directory.pot
- wp-content/plugins/sabai-googlemaps/languages/sabai-googlemaps.pot (optional)
- wp-content/plugins/sabai-paidlistings/languages/sabai-paidlistings.pot (optional)

Translate these files using a software like POEdit (recommended) and save the generated MO (.mo) files under wp-content/langauges/plugins (or under WP_LANG_DIR/plugins if WP_LANG_DIR is defined in your wp-config.php). Make sure that you append the lang code of your language to the file names. For example, if you are translating sabai.pot into French, save the generated MO file as sabai-fr_FR.mo.

#### Resources

- POEdit
- Plural Forms

### G) Update Sabai Directory - top

#### Step 1: Update Files

All of our plugins can be updated from the Plugins page of WordPress dashboard just like other plugins distributed from wordpress.org. Make sure that you have a valid license code configured for the CodeCanyon.net Purchase Code Settings section on the Setings -> Sabai page.

Also when updating, you must always update both sabai and sabai-directory plugins (and possibly other sabai-xxx plugins if you have them installed as well) to the same version. The best way to ensure that is to use the bulk update feature of WordPress.

IMPORTANT! Updating from 1.2 to 1.3 - Unfortunately updating from version 1.2 to 1.3 is not possible using the online update. You must manually delete the sabai and sabai-directory folders from the wp-content/plugins directory using an FTP software. Also if you have been using cloned add-ons, make sure to delete all files under wp-content/sabai/System/clones. Then, upload the new plugin folders (sabai, sabai-directory, sabai-googlemaps, and sabai-paidlistings folders) to wp-content/plugins. You should NOT deactivate nor delete any sabai plugins from the Plugins page of WordPress dashboard. After uploading the folders, go to the Plugins page of WordPress dashboard. You may see an error message saying that certain add-ons are not installed or a white screen. However, do not worry and reload the page a few number of times until the page displays correctly, and then activate Sabai Directory, Sabai Google Maps, and Sabai Paid Listings plugins.

#### Step 2: Update Data

Next, go to Settings -> Sabai from the Wordpress administration dashboard and under the Sabai Add-ons section, upgrade all add-ons that are highlighted and have the Upgrade button displayed. Press the Upgrade button for each of these add-ons and follow the instructions displayed on the pop-up window. You can also do a bulk upgrade by checking the checkboxes on the left and pressing the Upgrade Checked button. Note that some add-ons may not be upgraded until certain add-ons have been upgraded first. Make sure to upgrade all add-ons until all add-ons are de-highlighted.

Also, depending on the upgrade package, there may be some add-ons that are newly available for installation. These add-ons will be listed on the Installable Add-ons table below the list of installed add-ons so you can click the Install button for each of them to make them active.

#### Step 3: Clear Cache

The last step is very simple. Go to Settings -> Sabai from the Wordpress administration dashboard and under the System Settings section, click the button labelled Clear Cache. If the cache is successfully cleared, you should see a green check button displayed next to the button that you just clicked.

That's it, you should have now successfully updated Sabai Directory to the latest version.

### H) FAQ - top

Please visit our online FAQ

Go To Table of Contents